updates for ebpf / full host profiling #29270
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
Architecture
Preview links (active after the
|
|
Created an editorial card for in-depth docs review. |
Gandem
reviewed
May 14, 2025
Co-authored-by: Nayef Ghattas <11560964+Gandem@users.noreply.github.com>
Co-authored-by: Nayef Ghattas <11560964+Gandem@users.noreply.github.com>
brett0000FF
reviewed
May 14, 2025
Comment on lines
+3
to
+7
| code_lang: ebpf | ||
| type: multi-code-lang | ||
| code_lang_weight: 90 | ||
| aliases: | ||
| - /tracing/profiler/enabling/ebpf/ |
There was a problem hiding this comment.
Suggested change
| code_lang: ebpf | |
| type: multi-code-lang | |
| code_lang_weight: 90 | |
| aliases: | |
| - /tracing/profiler/enabling/ebpf/ | |
| private: true |
Let's remove this for now so we can make the page private.
| @@ -0,0 +1,107 @@ | |||
| --- | |||
| title: Enabling the eBPF Profiler | |||
There was a problem hiding this comment.
Suggested change
| title: Enabling the eBPF Profiler | |
| title: Enabling the Full-Host Profiler |
What do you think about framing this as this as the full host profiler instead of eBPF?
Comment on lines
+17
to
+19
| <div class="alert alert-warning"> | ||
| <code>ebpf</code> is in beta. Datadog recommends evaluating the profiler in a non-sensitive environment before deploying in production. | ||
| </div> |
There was a problem hiding this comment.
Suggested change
| <div class="alert alert-warning"> | |
| <code>ebpf</code> is in beta. Datadog recommends evaluating the profiler in a non-sensitive environment before deploying in production. | |
| </div> | |
| {{< callout url="" btn_hidden="true" header="Try the Full-Host Profiler Preview!">}} | |
| The Full-Host Profiler is in Preview. | |
| {{< /callout >}} |
| <code>ebpf</code> is in beta. Datadog recommends evaluating the profiler in a non-sensitive environment before deploying in production. | ||
| </div> | ||
|
|
||
| The eBPF profiler is our eBPF-based host profiler built on OpenTelemetry and designed to send profiling data to the Datadog backend via the Datadog Agent. It supports symbolication for compiled languages and is optimized for containerized environments like Docker and Kubernetes. |
There was a problem hiding this comment.
Suggested change
| The eBPF profiler is our eBPF-based host profiler built on OpenTelemetry and designed to send profiling data to the Datadog backend via the Datadog Agent. It supports symbolication for compiled languages and is optimized for containerized environments like Docker and Kubernetes. | |
| The Full-Host Profiler is an eBPF-based profiling solution built on OpenTelemetry that sends profiling data to Datadog using the Datadog Agent. It supports symbolication for compiled languages and is optimized for containerized environments such as Docker and Kubernetes. | |
| ### Use cases | |
| The Full-Host Profiler is particularly valuable for: | |
| - Profiling open-source software components that aren't instrumented with Datadog's tracing libraries. | |
| - Analyzing performance across multi-language processes and runtimes. | |
| - Identifying resource bottlenecks at the host level, including detection of noisy neighbor processes. | |
I think a use cases section would be helpful. What do you think?
| : TBD | ||
|
|
||
| Debugging information | ||
| : Symbols should be available locallly or can be uploaded in CI via `datadog-ci` |
There was a problem hiding this comment.
Suggested change
| : Symbols should be available locallly or can be uploaded in CI via `datadog-ci` | |
| : Symbols should be available locallly or can be uploaded in CI with `datadog-ci` |
|
|
||
| ## Not sure what to do next? | ||
|
|
||
| The [Getting Started with Profiler][6] guide takes a sample service with a performance problem and shows you how to use Continuous Profiler to understand and fix the problem. |
There was a problem hiding this comment.
Suggested change
| The [Getting Started with Profiler][6] guide takes a sample service with a performance problem and shows you how to use Continuous Profiler to understand and fix the problem. | |
| After installing the Full-Host Profiler, see the [Getting Started with Profiler][6] to learn how to use Continuous Profiler to identify and fix performance problems. |
|
|
||
| TBD | ||
|
|
||
| ## Not sure what to do next? |
There was a problem hiding this comment.
Suggested change
| ## Not sure what to do next? | |
| ## What's next? |
|
|
||
| The [Getting Started with Profiler][6] guide takes a sample service with a performance problem and shows you how to use Continuous Profiler to understand and fix the problem. | ||
|
|
||
| ## Further Reading |
There was a problem hiding this comment.
Suggested change
| ## Further Reading | |
| ## Further reading |
|
|
||
| {{< partial name="whats-next/whats-next.html" >}} | ||
|
|
||
| [2]: shttps://github.com/DataDog/dd-otel-host-profiler/releases/ |
There was a problem hiding this comment.
Suggested change
| [2]: shttps://github.com/DataDog/dd-otel-host-profiler/releases/ | |
| [2]: https://github.com/DataDog/dd-otel-host-profiler/releases/ |
| @@ -17,8 +17,8 @@ The following tables summarize the features available for each language runtime. | |||
|
|
|||
| To use the Datadog Profiler, use at least the minimum versions summarized in the following table. For specific profile type availability by version, see [Profile types](#profile-types). | |||
|
|
|||
| | | [Java][1] | [Python][2] | [Go][3] | [Ruby][4] | [Node.js][5] | [.NET][6] | [PHP][7] | [Rust/C/C++][8] | | |||
| |-----------------------------------|:------------:|:----------------:|:-------------:|:--------------:|:-------------:|:-----------------------------------------------------------------------:|:-------------:|:---------------:| | |||
| | | [Java][1] | [Python][2] | [Go][3] | [Ruby][4] | [Node.js][5] | [.NET][6] | [PHP][7] | [Rust/C/C++][8] | [eBPF][9] | | |||
There was a problem hiding this comment.
If we want to make this page private, we should note that this is in Preview here or remove it for now.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do? What is the motivation?
This PR is to add documentation for our new profiler: eBPF / full host. This includes general explanations, set up instructions, and troubleshooting.
Merge instructions
Merge readiness:
For Datadog employees:
Merge queue is enabled in this repo. Your branch name MUST follow the
<name>/<description>convention and include the forward slash (/). Without this format, your pull request will not pass in CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.If your branch doesn't follow this format, rename it or create a new branch and PR.
To have your PR automatically merged after it receives the required reviews, add the following PR comment:
Additional notes